/** 
 *  Copyright 2010 Matthew Werny & Burk Price.
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */
package net.iceflow.db.migration.experimental.model;

import java.util.Date;

/**
 * Read-only data store profile information.
 * @version 1.0
 */
public interface DataStoreDetails extends Comparable<Object> {

   /**
    * Gets the unique name of the datastore.
    * @return unique name
    */
   String getName();

   /**
    * Gets the human readable description of the datastore.
    * @return description
    */
   String getDescription();

   /**
    * Gets the type identifier that indicates the unique name under which the datastore interaction provider is registered.
    * @return type identifier
    */
   String getType();

   /**
    * Gets the highest migration level, to which the datastore may be migrated.
    * @return Highest migration level
    */
   long getMaximumMigrationLevel();

   /**
    * Gets the current level of migration of the data store.
    * @return Current migration level
    */
   long getCurrentMigrationLevel();

   /**
    * Gets the date at which the last migration upgrade/downgrade took place.
    * @return Date of last migration execution
    */
   Date getLastMigrationApplicationDate();

   /**
    * Indicates whether the datastore profile is active in the configuration.
    * @return Truth of whether the profile is active.
    */
   boolean isActive();

}
